cs-apolo-sapi-v2
📘 Documentación de la API - cs-apolo-sapi-v2
Esta sección describe los atributos y uso del servicio cs-apolo-sapi-v2.
💂️ Información Base
- Título de la API: cs-apolo-sapi-v2
- Versión: 2.0.0
- URL Base:
https://cs-apolo-sapi-v2-{env}.us-e1.cloudhub.io/api/
Reemplaza el segmento de entorno con:
dev
(Desarrollo)qa
(Aseguramiento de Calidad)prod
(Producción)
🔑 Autenticación
Encabezados Requeridos
Encabezado | Tipo | Descripción |
---|---|---|
client_id | String | Identificador único para clientes API |
invoker | String | JSON con información del invocador |
- client_id
- Longitud: 32 - 36 caracteres
- Ejemplo:
123e4567-e89b-12d3-a456-426614174000
- invoker
- Ejemplo:
{ "application": "Portal","addressIPUser": "192.168.80.13","loginUser": "User","userName": "User Name" }
- Ejemplo:
📌 Estos encabezados son requeridos en todas las solicitudes.
🔒 Endpoint: Crear Trabajador Dependiente
POST /create-dependent-worker
- Descripción: Crea un nuevo trabajador dependiente en el sistema.
URL Completa
https://cs-apolo-sapi-v2-dev.us-e1.cloudhub.io/api/create-dependent-worker
Método HTTP
POST
Encabezados Requeridos
client_id: TU_CLIENT_ID
invoker: { "application": "Portal","addressIPUser": "192.168.80.13","loginUser": "User","userName": "User Name" }
Content-Type: application/json
Autenticación
Aplicación de ID de Cliente y oauth2
Cuerpo de la Solicitud
{
"worker": {
"firstName": "Juan",
"lastName": "Pérez",
"identificationType": "CC",
"identificationNumber": "1234567890",
"birthDate": "1985-06-15",
"gender": "M",
"email": "juan.perez@example.com",
"phone": "3107894561",
"address": "Calle 123 # 45-67",
"cityCode": "11001"
},
"contract": {
"consecutiveContract": "59",
"consecutiveHeadquarter": "483",
"workCenter": "1",
"salary": "1500000",
"position": "Analista",
"startDate": "2025-01-15",
"riskLevel": "2",
"workday": "D",
"epsCode": "EPS001",
"afpCode": "AFP001"
}
}
Ejemplo de Solicitud
curl -X POST "https://cs-apolo-sapi-v2-dev.us-e1.cloudhub.io/api/create-dependent-worker" \
-H "client_id: TU_CLIENT_ID" \
-H "invoker: { \"application\": \"Portal\",\"addressIPUser\": \"192.168.80.13\",\"loginUser\": \"User\",\"userName\": \"User Name\" }" \
-H "Content-Type: application/json" \
-d '{
"worker": {
"firstName": "Juan",
"lastName": "Pérez",
"identificationType": "CC",
"identificationNumber": "1234567890",
"birthDate": "1985-06-15",
"gender": "M",
"email": "juan.perez@example.com",
"phone": "3107894561",
"address": "Calle 123 # 45-67",
"cityCode": "11001"
},
"contract": {
"consecutiveContract": "59",
"consecutiveHeadquarter": "483",
"workCenter": "1",
"salary": "1500000",
"position": "Analista",
"startDate": "2025-01-15",
"riskLevel": "2",
"workday": "D",
"epsCode": "EPS001",
"afpCode": "AFP001"
}
}'
Ejemplo de Respuesta
{
"status": "SUCCESS",
"code": "200",
"message": "Trabajador dependiente creado exitosamente",
"data": {
"workerConsecutive": "7845623",
"identificationNumber": "1234567890",
"identificationType": "CC",
"contractConsecutive": "59",
"affiliationDate": "2025-01-15T00:00:00Z"
}
}
⚠️ Códigos de Error
Código | Descripción | Solución Sugerida |
---|---|---|
400 | Solicitud Incorrecta | Verificar sintaxis y parámetros de la solicitud. |
401 | No Autorizado | Validar credenciales de autenticación. |
404 | No Encontrado | Confirmar la URL del endpoint. |
500 | Error Interno del Servidor | Reintentar o contactar soporte técnico. |
📞 Soporte
Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.
Correo electrónico: epalma@fgs.co
📅 Información Adicional
- Documentación actualizada por última vez: Julio 2025
- Para actualizaciones adicionales, consulta el Portal de Exchange de API
Documentación actualizada en julio 2025 por epalma@fgs.co - Edna Nayibe Palma
© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API cs-utilities-system-api-services